Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitafd136a

Browse files
authored
Merge pull request#40 from Jules-Bertholet/document-widths
Document width rules
2 parents00ee4b0 +1e623c5 commitafd136a

File tree

4 files changed

+71
-40
lines changed

4 files changed

+71
-40
lines changed

‎.github/workflows/rust.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name:Rust
1+
name:build
22

33
on:
44
push:

‎Cargo.toml‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,13 @@ authors = [
99

1010
homepage ="https://github.com/unicode-rs/unicode-width"
1111
repository ="https://github.com/unicode-rs/unicode-width"
12-
documentation ="https://unicode-rs.github.io/unicode-width"
13-
license ="MIT/Apache-2.0"
12+
license ="MIT OR Apache-2.0"
13+
categories = [
14+
"command-line-interface",
15+
"internationalization",
16+
"no-std::no-alloc",
17+
"text-processing",
18+
]
1419
keywords = ["text","width","unicode"]
1520
readme ="README.md"
1621
description ="""

‎README.md‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
#unicode-width
1+
#`unicode-width`
22

3-
Determine displayed width of`char` and`str` types according to
4-
[Unicode Standard Annex#11][UAX11] rules.
3+
[![Build status](https://github.com/unicode-rs/unicode-width/actions/workflows/rust.yml/badge.svg)](https://travis-ci.org/unicode-rs/unicode-width)
4+
[![crates.io version](https://img.shields.io/crates/v/unicode-width)](https://crates.io/crates/unicode-width)
5+
[![Docs status](https://img.shields.io/docsrs/unicode-width)](https://docs.rs/unicode-width/)
56

6-
[UAX11]:http://www.unicode.org/reports/tr11/
7+
Determine displayed width of`char` and`str` types according to[Unicode Standard Annex#11][UAX11],
8+
other portions of the Unicode standard, and common implementations of POSIX[`wcwidth()`](https://pubs.opengroup.org/onlinepubs/9699919799/).
79

8-
[![Build Status](https://travis-ci.org/unicode-rs/unicode-width.svg)](https://travis-ci.org/unicode-rs/unicode-width)
10+
This crate is`#![no_std]`.
911

10-
[Documentation](https://unicode-rs.github.io/unicode-width/unicode_width/index.html)
12+
[UAX11]:http://www.unicode.org/reports/tr11/
1113

1214
```rust
13-
externcrate unicode_width;
14-
1515
useunicode_width::UnicodeWidthStr;
1616

1717
fnmain() {
@@ -45,17 +45,12 @@ and nonstandard [Korean jamo](https://unicode.org/glossary/#jamo) sequences may
4545
be rendered with a different width than what this crate says. (This is not an
4646
exhaustive list.)
4747

48-
##features
49-
50-
unicode-width does not depend on libstd, so it can be used in crates
51-
with the`#![no_std]` attribute.
52-
5348
##crates.io
5449

5550
You can use this package in your project by adding the following
5651
to your`Cargo.toml`:
5752

5853
```toml
5954
[dependencies]
60-
unicode-width ="0.1.7"
55+
unicode-width ="0.1.11"
6156
```

‎src/lib.rs‎

Lines changed: 54 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,40 +9,71 @@
99
// except according to those terms.
1010

1111
//! Determine displayed width of `char` and `str` types according to
12-
//! [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/)
13-
//! rules.
12+
//! [Unicode Standard Annex #11](http://www.unicode.org/reports/tr11/),
13+
//! other portions of the Unicode standard, and common implementations of
14+
//! POSIX [`wcwidth()`](https://pubs.opengroup.org/onlinepubs/9699919799/).
15+
//! See the [Rules for determining width](#rules-for-determining-width) section
16+
//! for the exact rules.
1417
//!
15-
//! ```rust
16-
//! extern crate unicode_width;
18+
//! This crate is `#![no_std]`.
1719
//!
20+
//! ```rust
1821
//! use unicode_width::UnicodeWidthStr;
1922
//!
20-
//! fn main() {
21-
//! let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
22-
//! let width = UnicodeWidthStr::width(teststr);
23-
//! println!("{}", teststr);
24-
//! println!("The above string is {} columns wide.", width);
25-
//! let width = teststr.width_cjk();
26-
//! println!("The above string is {} columns wide (CJK).", width);
27-
//! }
23+
//! let teststr = "Ｈｅｌｌｏ, ｗｏｒｌｄ!";
24+
//! let width = UnicodeWidthStr::width(teststr);
25+
//! println!("{}", teststr);
26+
//! println!("The above string is {} columns wide.", width);
27+
//! let width = teststr.width_cjk();
28+
//! println!("The above string is {} columns wide (CJK).", width);
2829
//! ```
2930
//!
30-
//! #features
31+
//! #Rules for determining width
3132
//!
32-
//!unicode-width does not depend on `std`, so it can be used in crates
33-
//!with the `#![no_std]` attribute.
33+
//!This crate currently uses the following rules to determine the width of a
34+
//!character or string, in order of decreasing precedence. These may be tweaked in the future.
3435
//!
35-
//! # crates.io
36+
//! 1. [`'\u{00AD}'` SOFT HYPHEN](https://util.unicode.org/UnicodeJsps/character.jsp?a=00AD) has width 1.
37+
//! 2. [`'\u{115F}'` HANGUL CHOSEONG FILLER](https://util.unicode.org/UnicodeJsps/character.jsp?a=115F) has width 2.
38+
//! 3. The following have width 0:
39+
//! - [Characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BDefault_Ignorable_Code_Point%7D)
40+
//! with the [`Default_Ignorable_Code_Point`](https://www.unicode.org/versions/Unicode15.0.0/ch05.pdf#G40095) property.
41+
//! - [Characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BGrapheme_Extend%7D)
42+
//! with the [`Grapheme_Extend`] property.
43+
//! - The following 8 characters, all of which have NFD decompositions consisting of two [`Grapheme_Extend`] chracters:
44+
//! - [`'\u{0CC0}'` KANNADA VOWEL SIGN II](https://util.unicode.org/UnicodeJsps/character.jsp?a=0CC0),
45+
//! - [`'\u{0CC7}'` KANNADA VOWEL SIGN EE](https://util.unicode.org/UnicodeJsps/character.jsp?a=0CC7),
46+
//! - [`'\u{0CC8}'` KANNADA VOWEL SIGN AI](https://util.unicode.org/UnicodeJsps/character.jsp?a=0CC8),
47+
//! - [`'\u{0CCA}'` KANNADA VOWEL SIGN O](https://util.unicode.org/UnicodeJsps/character.jsp?a=0CCA),
48+
//! - [`'\u{0CCB}'` KANNADA VOWEL SIGN OO](https://util.unicode.org/UnicodeJsps/character.jsp?a=0CCB),
49+
//! - [`'\u{1B3B}'` BALINESE VOWEL SIGN RA REPA TEDUNG](https://util.unicode.org/UnicodeJsps/character.jsp?a=1B3B),
50+
//! - [`'\u{1B3D}'` BALINESE VOWEL SIGN LA LENGA TEDUNG](https://util.unicode.org/UnicodeJsps/character.jsp?a=1B3D), and
51+
//! - [`'\u{1B43}'` BALINESE VOWEL SIGN PEPET TEDUNG](https://util.unicode.org/UnicodeJsps/character.jsp?a=1B43).
52+
//! - [Characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BHangul_Syllable_Type%3DV%7D%5Cp%7BHangul_Syllable_Type%3DT%7D)
53+
//! with a [`Hangul_Syllable_Type`](https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G45593)
54+
//! of `Vowel_Jamo` (`V`) or `Trailing_Jamo` (`T`).
55+
//! - [`'\0'` NUL](https://util.unicode.org/UnicodeJsps/character.jsp?a=0000).
56+
//! 4. The [control characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BCc%7D)
57+
//! have no defined width, and are ignored when determining the width of a string.
58+
//! 5. [Characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BEast_Asian_Width%3DF%7D%5Cp%7BEast_Asian_Width%3DW%7D)
59+
//! with an [`East_Asian_Width`] of [`Fullwidth` (`F`)](https://www.unicode.org/reports/tr11/#ED2)
60+
//! or [`Wide` (`W`)](https://www.unicode.org/reports/tr11/#ED4) have width 2.
61+
//! 6. [Characters](https://util.unicode.org/UnicodeJsps/list-unicodeset.jsp?a=%5Cp%7BEast_Asian_Width%3DA%7D)
62+
//! with an [`East_Asian_Width`] of [`Ambiguous` (`A`)](https://www.unicode.org/reports/tr11/#ED6)
63+
//! have width 2 in an East Asian context, and width 1 otherwise.
64+
//! 7. All other characters have width 1.
3665
//!
37-
//! You can use this package in your project by adding the following
38-
//! to your `Cargo.toml`:
66+
//! [`East_Asian_Width`]: https://www.unicode.org/reports/tr11/#ED1
67+
//! [`Grapheme_Extend`]: https://www.unicode.org/versions/Unicode15.0.0/ch03.pdf#G52443
68+
3969
//!
40-
//!```toml
41-
//! [dependencies]
42-
//!unicode-width= "0.1.5"
43-
//!```
70+
//!## Canonical equivalence
71+
//!
72+
//!The non-CJKwidthmethods guarantee that canonically equivalent strings are assigned the same width.
73+
//!However, this guarantee does not currently hold for the CJK width variants.
4474
45-
#![deny(missing_docs, unsafe_code)]
75+
#![forbid(unsafe_code)]
76+
#![deny(missing_docs)]
4677
#![doc(
4778
html_logo_url ="https://unicode-rs.github.io/unicode-rs_sm.png",
4879
html_favicon_url ="https://unicode-rs.github.io/unicode-rs_sm.png"

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp