-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature] Add ASCII module and TODO: ascii DAO name (#161)
* add ASCII module
- Loading branch information
Showing
14 changed files
with
155 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| module StarcoinFramework::ASCII { | ||
| use StarcoinFramework::Vector; | ||
| use StarcoinFramework::Errors; | ||
| use StarcoinFramework::Option::{Self, Option}; | ||
|
|
||
| /// An invalid ASCII character was encountered when creating an ASCII string. | ||
| const EINVALID_ASCII_CHARACTER: u64 = 101; | ||
|
|
||
| /// The `String` struct holds a vector of bytes that all represent | ||
| /// valid ASCII characters. Note that these ASCII characters may not all | ||
| /// be printable. To determine if a `String` contains only "printable" | ||
| /// characters you should use the `all_characters_printable` predicate | ||
| /// defined in this module. | ||
| struct String has copy, drop, store { | ||
| bytes: vector<u8>, | ||
| } | ||
|
|
||
|
|
||
| /// An ASCII character. | ||
| struct Char has copy, drop, store { | ||
| byte: u8, | ||
| } | ||
|
|
||
| /// Convert a `byte` into a `Char` that is checked to make sure it is valid ASCII. | ||
| public fun char(byte: u8): Char { | ||
| assert!(is_valid_char(byte), Errors::invalid_argument(EINVALID_ASCII_CHARACTER)); | ||
| Char { byte } | ||
| } | ||
|
|
||
|
|
||
| /// Convert a vector of bytes `bytes` into an `String`. Aborts if | ||
| /// `bytes` contains non-ASCII characters. | ||
| public fun string(bytes: vector<u8>): String { | ||
| let x = try_string(bytes); | ||
| assert!( | ||
| Option::is_some(&x), | ||
| Errors::invalid_argument(EINVALID_ASCII_CHARACTER) | ||
| ); | ||
| Option::destroy_some(x) | ||
| } | ||
|
|
||
| /// Convert a vector of bytes `bytes` into an `String`. Returns | ||
| /// `Some(<ascii_string>)` if the `bytes` contains all valid ASCII | ||
| /// characters. Otherwise returns `None`. | ||
| public fun try_string(bytes: vector<u8>): Option<String> { | ||
| let len = Vector::length(&bytes); | ||
| let i = 0; | ||
| while ( i < len ) { | ||
| let possible_byte = *Vector::borrow(&bytes, i); | ||
| if (!is_valid_char(possible_byte)) return Option::none(); | ||
| i = i + 1; | ||
| }; | ||
| Option::some(String { bytes }) | ||
| } | ||
|
|
||
| /// Returns `true` if all characters in `string` are printable characters | ||
| /// Returns `false` otherwise. Not all `String`s are printable strings. | ||
| public fun all_characters_printable(string: &String): bool { | ||
| let len = Vector::length(&string.bytes); | ||
| let i = 0; | ||
| while ( i < len ) { | ||
| let byte = *Vector::borrow(&string.bytes, i); | ||
| if (!is_printable_char(byte)) return false; | ||
| i = i + 1; | ||
| }; | ||
| true | ||
| } | ||
|
|
||
| public fun push_char(string: &mut String, char: Char) { | ||
| Vector::push_back(&mut string.bytes, char.byte); | ||
| } | ||
|
|
||
|
|
||
| public fun pop_char(string: &mut String): Char { | ||
| Char { byte: Vector::pop_back(&mut string.bytes) } | ||
| } | ||
|
|
||
|
|
||
| public fun length(string: &String): u64 { | ||
| Vector::length(as_bytes(string)) | ||
| } | ||
|
|
||
| /// Get the inner bytes of the `string` as a reference | ||
| public fun as_bytes(string: &String): &vector<u8> { | ||
| &string.bytes | ||
| } | ||
|
|
||
| /// Unpack the `string` to get its backing bytes | ||
| public fun into_bytes(string: String): vector<u8> { | ||
| let String { bytes } = string; | ||
| bytes | ||
| } | ||
|
|
||
| /// Unpack the `char` into its underlying byte. | ||
| public fun byte(char: Char): u8 { | ||
| let Char { byte } = char; | ||
| byte | ||
| } | ||
|
|
||
| /// Returns `true` if `byte` is a valid ASCII character. Returns `false` otherwise. | ||
| public fun is_valid_char(byte: u8): bool { | ||
| byte <= 0x7F | ||
| } | ||
|
|
||
| /// Returns `true` if `byte` is an printable ASCII character. Returns `false` otherwise. | ||
| public fun is_printable_char(byte: u8): bool { | ||
| byte >= 0x20 && // Disallow metacharacters | ||
| byte <= 0x7E // Don't allow DEL metacharacter | ||
| } | ||
|
|
||
| /// split string by char. Returns vector<String> | ||
| public fun split_by_char(string: String, char: Char): vector<String> { | ||
| let result = Vector::empty<String>(); | ||
| let len = length(&string); | ||
| let i = 0; | ||
| let buffer = Vector::empty<u8>(); | ||
| while ( i < len ) { | ||
| let byte = *Vector::borrow(&string.bytes, i); | ||
| if (byte != char.byte) { | ||
| Vector::push_back(&mut buffer, byte); | ||
| } else { | ||
| Vector::push_back(&mut result, string(buffer)); | ||
| buffer = Vector::empty<u8>(); | ||
| if (i != 0 && i == len - 1) { | ||
| // special | ||
| Vector::push_back(&mut result, string(copy buffer)); | ||
| }; | ||
| }; | ||
|
|
||
| i = i + 1; | ||
| }; | ||
|
|
||
| if (len == 0 || Vector::length(&buffer) != 0) { | ||
| Vector::push_back(&mut result, string(buffer)); | ||
| }; | ||
| result | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters