aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/man3/tomo-Text.from_utf16.339
-rw-r--r--man/man3/tomo-Text.from_utf32.3 (renamed from man/man3/tomo-Text.from_codepoints.3)8
-rw-r--r--man/man3/tomo-Text.from_utf8.3 (renamed from man/man3/tomo-Text.from_bytes.3)8
-rw-r--r--man/man3/tomo-Text.utf16.336
-rw-r--r--man/man3/tomo-Text.utf32.3 (renamed from man/man3/tomo-Text.utf32_codepoints.3)8
-rw-r--r--man/man3/tomo-Text.utf8.3 (renamed from man/man3/tomo-Text.bytes.3)8
6 files changed, 91 insertions, 16 deletions
diff --git a/man/man3/tomo-Text.from_utf16.3 b/man/man3/tomo-Text.from_utf16.3
new file mode 100644
index 00000000..d4eaea02
--- /dev/null
+++ b/man/man3/tomo-Text.from_utf16.3
@@ -0,0 +1,39 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Text.from_utf16 3 2025-09-09 "Tomo man-pages"
+.SH NAME
+Text.from_utf16 \- convert UTF16 list to text
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI Text.from_utf16\ :\ func(bytes:\ [Int16]\ ->\ [Text])
+.fi
+.SH DESCRIPTION
+Returns text that has been constructed from the given UTF16 sequence.
+
+
+.SH ARGUMENTS
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+bytes [Int16] The UTF-16 integers of the desired text. -
+.TE
+.SH RETURN
+A new text based on the input UTF16 sequence after normalization has been applied.
+
+.SH NOTES
+The text will be normalized, so the resulting text's UTF16 sequence may not exactly match the input.
+
+.SH EXAMPLES
+.EX
+>> Text.from_utf16([197, 107, 101])
+= "Åke"
+>> Text.from_utf16([12371, 12435, 12395, 12385, 12399, 19990, 30028])
+= "こんにちは世界".utf16()
+.EE
diff --git a/man/man3/tomo-Text.from_codepoints.3 b/man/man3/tomo-Text.from_utf32.3
index cfc3133b..31fc344f 100644
--- a/man/man3/tomo-Text.from_codepoints.3
+++ b/man/man3/tomo-Text.from_utf32.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_codepoints 3 2025-09-06 "Tomo man-pages"
+.TH Text.from_utf32 3 2025-09-09 "Tomo man-pages"
.SH NAME
-Text.from_codepoints \- convert UTF32 codepoints to text
+Text.from_utf32 \- convert UTF32 codepoints to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Text.from_codepoints\ :\ func(codepoints:\ [Int32]\ ->\ [Text])
+.BI Text.from_utf32\ :\ func(codepoints:\ [Int32]\ ->\ [Text])
.fi
.SH DESCRIPTION
Returns text that has been constructed from the given UTF32 codepoints.
@@ -32,6 +32,6 @@ The text will be normalized, so the resulting text's codepoints may not exactly
.SH EXAMPLES
.EX
->> Text.from_codepoints([197, 107, 101])
+>> Text.from_utf32([197, 107, 101])
= "Åke"
.EE
diff --git a/man/man3/tomo-Text.from_bytes.3 b/man/man3/tomo-Text.from_utf8.3
index a21bb169..ead65dc6 100644
--- a/man/man3/tomo-Text.from_bytes.3
+++ b/man/man3/tomo-Text.from_utf8.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.from_bytes 3 2025-09-06 "Tomo man-pages"
+.TH Text.from_utf8 3 2025-09-09 "Tomo man-pages"
.SH NAME
-Text.from_bytes \- convert UTF8 byte list to text
+Text.from_utf8 \- convert UTF8 byte list to text
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Text.from_bytes\ :\ func(bytes:\ [Byte]\ ->\ [Text])
+.BI Text.from_utf8\ :\ func(bytes:\ [Byte]\ ->\ [Text])
.fi
.SH DESCRIPTION
Returns text that has been constructed from the given UTF8 bytes.
@@ -32,6 +32,6 @@ The text will be normalized, so the resulting text's UTF8 bytes may not exactly
.SH EXAMPLES
.EX
->> Text.from_bytes([195, 133, 107, 101])
+>> Text.from_utf8([195, 133, 107, 101])
= "Åke"
.EE
diff --git a/man/man3/tomo-Text.utf16.3 b/man/man3/tomo-Text.utf16.3
new file mode 100644
index 00000000..2b3da2b1
--- /dev/null
+++ b/man/man3/tomo-Text.utf16.3
@@ -0,0 +1,36 @@
+'\" t
+.\" Copyright (c) 2025 Bruce Hill
+.\" All rights reserved.
+.\"
+.TH Text.utf16 3 2025-09-09 "Tomo man-pages"
+.SH NAME
+Text.utf16 \- get UTF16 codepoints
+.SH LIBRARY
+Tomo Standard Library
+.SH SYNOPSIS
+.nf
+.BI Text.utf16\ :\ func(text:\ Text\ ->\ [Int16])
+.fi
+.SH DESCRIPTION
+Returns a list of Unicode code points for UTF16 encoding of the text.
+
+
+.SH ARGUMENTS
+
+.TS
+allbox;
+lb lb lbx lb
+l l l l.
+Name Type Description Default
+text Text The text from which to extract Unicode code points. -
+.TE
+.SH RETURN
+A list of 16-bit integer Unicode code points (`[Int16]`).
+
+.SH EXAMPLES
+.EX
+>> "Åke".utf16()
+= [197, 107, 101]
+>> "こんにちは世界".utf16()
+= [12371, 12435, 12395, 12385, 12399, 19990, 30028]
+.EE
diff --git a/man/man3/tomo-Text.utf32_codepoints.3 b/man/man3/tomo-Text.utf32.3
index d5b218d6..ff37ba9c 100644
--- a/man/man3/tomo-Text.utf32_codepoints.3
+++ b/man/man3/tomo-Text.utf32.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.utf32_codepoints 3 2025-09-06 "Tomo man-pages"
+.TH Text.utf32 3 2025-09-09 "Tomo man-pages"
.SH NAME
-Text.utf32_codepoints \- get UTF32 codepoints
+Text.utf32 \- get UTF32 codepoints
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Text.utf32_codepoints\ :\ func(text:\ Text\ ->\ [Int32])
+.BI Text.utf32\ :\ func(text:\ Text\ ->\ [Int32])
.fi
.SH DESCRIPTION
Returns a list of Unicode code points for UTF32 encoding of the text.
@@ -29,6 +29,6 @@ A list of 32-bit integer Unicode code points (`[Int32]`).
.SH EXAMPLES
.EX
->> "Amélie".utf32_codepoints()
+>> "Amélie".utf32()
= [65, 109, 233, 108, 105, 101]
.EE
diff --git a/man/man3/tomo-Text.bytes.3 b/man/man3/tomo-Text.utf8.3
index b97d8632..80a91fb9 100644
--- a/man/man3/tomo-Text.bytes.3
+++ b/man/man3/tomo-Text.utf8.3
@@ -2,14 +2,14 @@
.\" Copyright (c) 2025 Bruce Hill
.\" All rights reserved.
.\"
-.TH Text.bytes 3 2025-09-06 "Tomo man-pages"
+.TH Text.utf8 3 2025-09-09 "Tomo man-pages"
.SH NAME
-Text.bytes \- get UTF8 bytes
+Text.utf8 \- get UTF8 bytes
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
-.BI Text.bytes\ :\ func(text:\ Text\ ->\ [Byte])
+.BI Text.utf8\ :\ func(text:\ Text\ ->\ [Byte])
.fi
.SH DESCRIPTION
Converts a `Text` value to a list of bytes representing a UTF8 encoding of the text.
@@ -29,6 +29,6 @@ A list of bytes (`[Byte]`) representing the text in UTF8 encoding.
.SH EXAMPLES
.EX
->> "Amélie".bytes()
+>> "Amélie".utf8()
= [65, 109, 195, 169, 108, 105, 101]
.EE