Z.Data.Text.Base

A Text wrap a Bytes which will be interpreted using UTF-8 encoding. User should always use validate to construt a Text (instead of using construtor directly or coercing), otherwise illegal UTF-8 encoded codepoints will cause undefined behaviours.

Text type

newtype Text

Text represented as UTF-8 encoded Bytes

Constructors

Text

Fields

• getUTF8Bytes :: Bytes

  Extract UTF-8 encoded Bytes from Text

Instances

IsList Text

Defined in Z.Data.Text.Base

Associated Types

type Item Text

Methods

fromList :: [Item Text] -> Text

fromListN :: Int -> [Item Text] -> Text

toList :: Text -> [Item Text]

Eq Text

Defined in Z.Data.Text.Base

Methods

(==) :: Text -> Text -> Bool

(/=) :: Text -> Text -> Bool

Ord Text

Defined in Z.Data.Text.Base

Methods

compare :: Text -> Text -> Ordering

(<) :: Text -> Text -> Bool

(<=) :: Text -> Text -> Bool

(>) :: Text -> Text -> Bool

(>=) :: Text -> Text -> Bool

max :: Text -> Text -> Text

min :: Text -> Text -> Text

Read Text

Accepted syntax and escaping rules are same with String, which is different from Show instance.

Defined in Z.Data.Text.Base

Methods

readsPrec :: Int -> ReadS Text

readList :: ReadS [Text]

readPrec :: ReadPrec Text

readListPrec :: ReadPrec [Text]

Show Text

The escaping rules is different from String 's Show instance, see "Z.Data.Text.Builder.escapeTextJSON"

Defined in Z.Data.Text.Base

Methods

showsPrec :: Int -> Text -> ShowS

show :: Text -> String

showList :: [Text] -> ShowS

IsString Text

Defined in Z.Data.Text.Base

Methods

fromString :: String -> Text

Semigroup Text

Defined in Z.Data.Text.Base

Methods

(<>) :: Text -> Text -> Text

sconcat :: NonEmpty Text -> Text

stimes :: Integral b => b -> Text -> Text

Monoid Text

Defined in Z.Data.Text.Base

Methods

mempty :: Text

mappend :: Text -> Text -> Text

mconcat :: [Text] -> Text

Arbitrary Text

Defined in Z.Data.Text.Base

Methods

arbitrary :: Gen Text

shrink :: Text -> [Text]

CoArbitrary Text

Defined in Z.Data.Text.Base

Methods

coarbitrary :: Text -> Gen b -> Gen b

FoldCase Text

case fold with default locale.

Defined in Z.Data.Text.Base

Methods

foldCase :: Text -> Text

foldCaseList :: [Text] -> [Text]

NFData Text

Defined in Z.Data.Text.Base

Methods

rnf :: Text -> ()

Hashable Text

Defined in Z.Data.Text.Base

Methods

hashWithSalt :: Int -> Text -> Int

hash :: Text -> Int

Print Text

The escaping rules is same with Show instance: we reuse JSON escaping rules here, so it will be faster.

Defined in Z.Data.Text.Print

Methods

toUTF8BuilderP :: Int -> Text -> Builder ()

JSON Text

Defined in Z.Data.JSON.Base

Methods

fromValue :: Value -> Converter Text

toValue :: Text -> Value

encodeJSON :: Text -> Builder ()

JSON a => JSON (Map Text a)

Defined in Z.Data.JSON.Base

Methods

fromValue :: Value -> Converter (Map Text a)

toValue :: Map Text a -> Value

encodeJSON :: Map Text a -> Builder ()

JSON a => JSON (HashMap Text a)

default instance prefer later key

Defined in Z.Data.JSON.Base

Methods

fromValue :: Value -> Converter (HashMap Text a)

toValue :: HashMap Text a -> Value

encodeJSON :: HashMap Text a -> Builder ()

JSON a => JSON (FlatMap Text a)

default instance prefer later key

Defined in Z.Data.JSON.Base

Methods

fromValue :: Value -> Converter (FlatMap Text a)

toValue :: FlatMap Text a -> Value

encodeJSON :: FlatMap Text a -> Builder ()

type Item Text

Defined in Z.Data.Text.Base

type Item Text = Char

Building text

validate :: HasCallStack => Bytes -> Text

O(n) Validate a sequence of bytes is UTF-8 encoded.

Throw InvalidUTF8Exception in case of invalid codepoint.

validateASCII :: HasCallStack => Bytes -> Text

O(n) Validate a sequence of bytes is all ascii char byte(<128).

Throw InvalidASCIIException in case of invalid byte, It's not always faster than validate, use it only if you want to validate ASCII char sequences.

validateMaybe :: Bytes -> Maybe Text

O(n) Validate a sequence of bytes is UTF-8 encoded.

Return Nothing in case of invalid codepoint.

validateASCIIMaybe :: Bytes -> Maybe Text

O(n) Validate a sequence of bytes is all ascii char byte(<128).

Return Nothing in case of invalid byte.

index :: HasCallStack => Text -> Int -> Char

O(n) Get the nth codepoint from Text, throw IndexOutOfTextRange when out of bound.

indexMaybe :: Text -> Int -> Maybe Char

O(n) Get the nth codepoint from Text.

charByteIndex :: Text -> Int -> Int

O(n) Find the nth codepoint's byte index (pointing to the nth char's begining byte).

The index is only meaningful to the whole byte slice, if there's less than n codepoints, the index will point to next byte after the end.

indexR :: HasCallStack => Text -> Int -> Char

O(n) Get the nth codepoint from Text counting from the end, throw IndexOutOfVectorRange n callStack when out of bound.

indexMaybeR :: Text -> Int -> Maybe Char

O(n) Get the nth codepoint from Text counting from the end.

charByteIndexR :: Text -> Int -> Int

O(n) Find the nth codepoint's byte index from the end (pointing to the previous char's ending byte).

The index is only meaningful to the whole byte slice, if there's less than n codepoints, the index will point to previous byte before the start.

Basic creating

empty :: Text

O(1). Empty text.

singleton :: Char -> Text

O(1). Single char text.

copy :: Text -> Text

O(n). Copy a text from slice.

replicate :: Int -> Char -> Text

O(n) replicate char n time.

cycleN :: Int -> Text -> Text

O(n*m) cycleN a text n times.

Conversion between list

pack :: String -> Text

O(n) Convert a string into a text

Alias for packN defaultInitSize, will be rewritten to a memcpy if possible.

packN :: Int -> String -> Text

O(n) Convert a list into a text with an approximate size(in bytes, not codepoints).

If the encoded bytes length is larger than the size given, we simply double the buffer size and continue building.

This function is a good consumer in the sense of build/foldr fusion.

packR :: String -> Text

O(n) Alias for packRN defaultInitSize.

packRN :: Int -> String -> Text

O(n) packN in reverse order.

This function is a good consumer in the sense of build/foldr fusion.

unpack :: Text -> String

O(n) Convert text to a char list.

Unpacking is done lazily. i.e. we will retain reference to the array until all element are consumed.

This function is a good producer in the sense of build/foldr fusion.

unpackR :: Text -> String

O(n) Convert text to a list in reverse order.

This function is a good producer in the sense of build/foldr fusion.

Conversion between codepoint vector

fromVector :: PrimVector Char -> Text

O(n) convert from a char vector.

toVector :: Text -> PrimVector Char

O(n) convert to a char vector.

Basic interface

null :: Text -> Bool

O(1) Test whether a text is empty.

length :: Text -> Int

O(n) The char length of a text.

append :: Text -> Text -> Text

O(m+n)

There's no need to guard empty vector because we guard them for you, so appending empty text are no-ops.

map' :: (Char -> Char) -> Text -> Text

O(n) map f t is the Text obtained by applying f to each char of t. Performs replacement on invalid scalar values.

imap' :: (Int -> Char -> Char) -> Text -> Text

Strict mapping with index.

foldl' :: (b -> Char -> b) -> b -> Text -> b

Strict left to right fold.

ifoldl' :: (b -> Int -> Char -> b) -> b -> Text -> b

Strict left to right fold with index.

foldr' :: (Char -> b -> b) -> b -> Text -> b

Strict right to left fold

ifoldr' :: (Int -> Char -> b -> b) -> b -> Text -> b

Strict right to left fold with index

NOTE: the index is counting from 0, not backwards

concat :: [Text] -> Text

O(n) Concatenate a list of text.

Note: concat have to force the entire list to filter out empty text and calculate the length for allocation.

concatMap :: (Char -> Text) -> Text -> Text

Map a function over a text and concatenate the results

Special folds

count :: Char -> Text -> Int

O(n) count returns count of an element from a text.

all :: (Char -> Bool) -> Text -> Bool

O(n) Applied to a predicate and text, all determines if all chars of the text satisfy the predicate.

any :: (Char -> Bool) -> Text -> Bool

O(n) Applied to a predicate and a text, any determines if any chars of the text satisfy the predicate.

Text display width

displayWidth :: Text -> Int

Get the display width of a piece of text.

You shouldn't pass texts with control characters(<0x20, \DEL), which are counted with -1 width.

>>> displayWidth "你好世界！"
>>> 10
>>> displayWidth "hello world!"
>>> 12

normalization

data NormalizationResult

Constructors

NormalizedYes

NormalizedMaybe

NormalizedNo

Instances

Eq NormalizationResult

Defined in Z.Data.Text.UTF8Rewind

Methods

(==) :: NormalizationResult -> NormalizationResult -> Bool

(/=) :: NormalizationResult -> NormalizationResult -> Bool

Ord NormalizationResult

Defined in Z.Data.Text.UTF8Rewind

Methods

compare :: NormalizationResult -> NormalizationResult -> Ordering

(<) :: NormalizationResult -> NormalizationResult -> Bool

(<=) :: NormalizationResult -> NormalizationResult -> Bool

(>) :: NormalizationResult -> NormalizationResult -> Bool

(>=) :: NormalizationResult -> NormalizationResult -> Bool

max :: NormalizationResult -> NormalizationResult -> NormalizationResult

min :: NormalizationResult -> NormalizationResult -> NormalizationResult

Show NormalizationResult

Defined in Z.Data.Text.UTF8Rewind

Methods

showsPrec :: Int -> NormalizationResult -> ShowS

show :: NormalizationResult -> String

showList :: [NormalizationResult] -> ShowS

Generic NormalizationResult

Defined in Z.Data.Text.UTF8Rewind

Associated Types

type Rep NormalizationResult :: Type -> Type

Methods

from :: NormalizationResult -> Rep NormalizationResult x

to :: Rep NormalizationResult x -> NormalizationResult

type Rep NormalizationResult

Defined in Z.Data.Text.UTF8Rewind

type Rep NormalizationResult = D1 ('MetaData "NormalizationResult" "Z.Data.Text.UTF8Rewind" "Z-Data-0.8.0.0-HsSgGWf38hS7UqVy0fQb1A" 'False) (C1 ('MetaCons "NormalizedYes" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "NormalizedMaybe" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NormalizedNo" 'PrefixI 'False) (U1 :: Type -> Type)))

data NormalizeMode

These are the Unicode Normalization Forms:

Form                         | Description
---------------------------- | ---------------------------------------------
Normalization Form D (NFD)   | Canonical decomposition
Normalization Form C (NFC)   | Canonical decomposition, followed by canonical composition
Normalization Form KD (NFKD) | Compatibility decomposition
Normalization Form KC (NFKC) | Compatibility decomposition, followed by canonical composition

Constructors

NFC

NFKC

NFD

NFKD

Instances

Eq NormalizeMode

Defined in Z.Data.Text.UTF8Rewind

Methods

(==) :: NormalizeMode -> NormalizeMode -> Bool

(/=) :: NormalizeMode -> NormalizeMode -> Bool

Ord NormalizeMode

Defined in Z.Data.Text.UTF8Rewind

Methods

compare :: NormalizeMode -> NormalizeMode -> Ordering

(<) :: NormalizeMode -> NormalizeMode -> Bool

(<=) :: NormalizeMode -> NormalizeMode -> Bool

(>) :: NormalizeMode -> NormalizeMode -> Bool

(>=) :: NormalizeMode -> NormalizeMode -> Bool

max :: NormalizeMode -> NormalizeMode -> NormalizeMode

min :: NormalizeMode -> NormalizeMode -> NormalizeMode

Show NormalizeMode

Defined in Z.Data.Text.UTF8Rewind

Methods

showsPrec :: Int -> NormalizeMode -> ShowS

show :: NormalizeMode -> String

showList :: [NormalizeMode] -> ShowS

Generic NormalizeMode

Defined in Z.Data.Text.UTF8Rewind

Associated Types

type Rep NormalizeMode :: Type -> Type

Methods

from :: NormalizeMode -> Rep NormalizeMode x

to :: Rep NormalizeMode x -> NormalizeMode

type Rep NormalizeMode

Defined in Z.Data.Text.UTF8Rewind

type Rep NormalizeMode = D1 ('MetaData "NormalizeMode" "Z.Data.Text.UTF8Rewind" "Z-Data-0.8.0.0-HsSgGWf38hS7UqVy0fQb1A" 'False) ((C1 ('MetaCons "NFC" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NFKC" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "NFD" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NFKD" 'PrefixI 'False) (U1 :: Type -> Type)))

isNormalized :: Text -> NormalizationResult

Check if a string is stable in the NFC (Normalization Form C).

isNormalizedTo :: NormalizeMode -> Text -> NormalizationResult

Check if a string is stable in the specified Unicode Normalization Form.

This function can be used as a preprocessing step, before attempting to normalize a string. Normalization is a very expensive process, it is often cheaper to first determine if the string is unstable in the requested normalization form.

The result of the check will be YES if the string is stable and MAYBE or NO if it is unstable. If the result is MAYBE, the string does not necessarily have to be normalized.

For more information, please review <http://www.unicode.org/reports/tr15/ Unicode Standard Annex #15 - Unicode Normalization Forms>.

normalize :: Text -> Text

Normalize a string to NFC (Normalization Form C).

normalizeTo :: NormalizeMode -> Text -> Text

Normalize a string to the specified Unicode Normalization Form.

The Unicode standard defines two standards for equivalence between characters: canonical and compatibility equivalence. Canonically equivalent characters and sequence represent the same abstract character and must be rendered with the same appearance and behavior. Compatibility equivalent characters have a weaker equivalence and may be rendered differently.

Unicode Normalization Forms are formally defined standards that can be used to test whether any two strings of characters are equivalent to each other. This equivalence may be canonical or compatibility.

The algorithm puts all combining marks into a specified order and uses the rules for decomposition and composition to transform the string into one of four Unicode Normalization Forms. A binary comparison can then be used to determine equivalence.

Case conversion

envLocale :: IO Locale

Get environment locale

caseFold :: Text -> Text

Remove case distinction from UTF-8 encoded text with default locale.

caseFoldWith :: Locale -> Text -> Text

Remove case distinction from UTF-8 encoded text.

Case folding is the process of eliminating differences between code points concerning case mapping. It is most commonly used for comparing strings in a case-insensitive manner. Conversion is fully compliant with the Unicode 7.0 standard.

Although similar to lowercasing text, there are significant differences. For one, case folding does _not_ take locale into account when converting. In some cases, case folding can be up to 20% faster than lowercasing the same text, but the result cannot be treated as correct lowercased text.

Only two locale-specific exception are made when case folding text. In Turkish, U+0049 LATIN CAPITAL LETTER I maps to U+0131 LATIN SMALL LETTER DOTLESS I and U+0130 LATIN CAPITAL LETTER I WITH DOT ABOVE maps to U+0069 LATIN SMALL LETTER I.

Although most code points can be case folded without changing length, there are notable exceptions. For example, U+0130 (LATIN CAPITAL LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL LETTER I and COMBINING DOT ABOVE) when converted to lowercase.

Only a handful of scripts make a distinction between upper- and lowercase. In addition to modern scripts, such as Latin, Greek, Armenian and Cyrillic, a few historic or archaic scripts have case. The vast majority of scripts do not have case distinctions.

toLower :: Text -> Text

Convert UTF-8 encoded text to lowercase with default locale.

toLowerWith :: Locale -> Text -> Text

Convert UTF-8 encoded text to lowercase.

This function allows conversion of UTF-8 encoded strings to lowercase without first changing the encoding to UTF-32. Conversion is fully compliant with the Unicode 7.0 standard.

Although most code points can be converted to lowercase with changing length, there are notable exceptions. For example, U+0130 (LATIN CAPITAL LETTER I WITH DOT ABOVE) maps to "U+0069 U+0307" (LATIN SMALL LETTER I and COMBINING DOT ABOVE) when converted to lowercase.

Only a handful of scripts make a distinction between upper- and lowercase. In addition to modern scripts, such as Latin, Greek, Armenian and Cyrillic, a few historic or archaic scripts have case. The vast majority of scripts do not have case distinctions.

Case mapping is not reversible. That is, toUpper(toLower(x)) != toLower(toUpper(x)).

Certain code points (or combinations of code points) apply rules based on the locale. For more information about these exceptional code points, please refer to the Unicode standard: ftp://ftp.unicode.org/Public/UNIDATA/SpecialCasing.txt

toUpper :: Text -> Text

Convert UTF-8 encoded text to uppercase with default locale.

toUpperWith :: Locale -> Text -> Text

Convert UTF-8 encoded text to uppercase.

Conversion is fully compliant with the Unicode 7.0 standard.

Although most code points can be converted without changing length, there are notable exceptions. For example, U+00DF (LATIN SMALL LETTER SHARP S) maps to "U+0053 U+0053" (LATIN CAPITAL LETTER S and LATIN CAPITAL LETTER S) when converted to uppercase.

Only a handful of scripts make a distinction between upper and lowercase. In addition to modern scripts, such as Latin, Greek, Armenian and Cyrillic, a few historic or archaic scripts have case. The vast majority of scripts do not have case distinctions.

Case mapping is not reversible. That is, toUpper(toLower(x)) != toLower(toUpper(x)).

Certain code points (or combinations of code points) apply rules based on the locale. For more information about these exceptional code points, please refer to the Unicode standard: ftp://ftp.unicode.org/Public/UNIDATA/SpecialCasing.txt

toTitle :: Text -> Text

Convert UTF-8 encoded text to titlecase with default locale.

toTitleWith :: Locale -> Text -> Text

Convert UTF-8 encoded text to titlecase.

This function allows conversion of UTF-8 encoded strings to titlecase. Conversion is fully compliant with the Unicode 7.0 standard.

Titlecase requires a bit more explanation than uppercase and lowercase, because it is not a common text transformation. Titlecase uses uppercase for the first letter of each word and lowercase for the rest. Words are defined as "collections of code points with general category Lu, Ll, Lt, Lm or Lo according to the Unicode database".

Effectively, any type of punctuation can break up a word, even if this is not grammatically valid. This happens because the titlecasing algorithm does not and cannot take grammar rules into account.

Text                                 | Titlecase
-------------------------------------|-------------------------------------
The running man                      | The Running Man
NATO Alliance                        | Nato Alliance
You're amazing at building libraries | You'Re Amazing At Building Libraries

Although most code points can be converted to titlecase without changing length, there are notable exceptions. For example, U+00DF (LATIN SMALL LETTER SHARP S) maps to "U+0053 U+0073" (LATIN CAPITAL LETTER S and LATIN SMALL LETTER S) when converted to titlecase.

Certain code points (or combinations of code points) apply rules based on the locale. For more information about these exceptional code points, please refer to the Unicode standard: ftp://ftp.unicode.org/Public/UNIDATA/SpecialCasing.txt

Unicode category

isCategory :: Category -> Text -> Bool

Check if the input string conforms to the category specified by the flags.

This function can be used to check if the code points in a string are part of a category. Valid flags are members of the "list of categories". The category for a code point is defined as part of the entry in UnicodeData.txt, the data file for the Unicode code point database.

By default, the function will treat grapheme clusters as a single code point. This means that the following string:

Code point | Canonical combining class | General category      | Name
---------- | ------------------------- | --------------------- | ----------------------
U+0045     | 0                         | Lu (Uppercase letter) | LATIN CAPITAL LETTER E
U+0300     | 230                       | Mn (Non-spacing mark) | COMBINING GRAVE ACCENT

Will match with CategoryLetterUppercase in its entirety, because the COMBINING GRAVE ACCENT is treated as part of the grapheme cluster. This is useful when e.g. creating a text parser, because you do not have to normalize the text first.

If this is undesired behavior, specify the CategoryIgnoreGraphemeCluster flag.

In order to maintain backwards compatibility with POSIX functions like isdigit and isspace, compatibility flags have been provided. Note, however, that the result is only guaranteed to be correct for code points in the Basic Latin range, between U+0000 and 0+007F. Combining a compatibility flag with a regular category flag will result in undefined behavior.

spanCategory :: Category -> Text -> (Text, Text)

Try to match as many code points with the matching category flags as possible and return the prefix and suffix.

Constants

Locale

type Locale = CSize

Locale for case mapping.

pattern LocaleDefault :: Locale

pattern LocaleLithuanian :: Locale

pattern LocaleTurkishAndAzeriLatin :: Locale

Category

type Category = CSize

Unicode categories.

See isCategory, you can combine categories with bitwise or.

pattern CategoryLetterUppercase :: Category

pattern CategoryLetterLowercase :: Category

pattern CategoryLetterTitlecase :: Category

pattern CategoryLetterOther :: Category

pattern CategoryLetter :: Category

pattern CategoryCaseMapped :: Category

pattern CategoryMarkNonSpacing :: Category

pattern CategoryMarkSpacing :: Category

pattern CategoryMarkEnclosing :: Category

pattern CategoryMark :: Category

pattern CategoryNumberDecimal :: Category

pattern CategoryNumberLetter :: Category

pattern CategoryNumberOther :: Category

pattern CategoryNumber :: Category

pattern CategoryPunctuationConnector :: Category

pattern CategoryPunctuationDash :: Category

pattern CategoryPunctuationOpen :: Category

pattern CategoryPunctuationClose :: Category

pattern CategoryPunctuationInitial :: Category

pattern CategoryPunctuationFinal :: Category

pattern CategoryPunctuationOther :: Category

pattern CategoryPunctuation :: Category

pattern CategorySymbolMath :: Category

pattern CategorySymbolCurrency :: Category

pattern CategorySymbolModifier :: Category

pattern CategorySymbolOther :: Category

pattern CategorySymbol :: Category

pattern CategorySeparatorSpace :: Category

pattern CategorySeparatorLine :: Category

pattern CategorySeparatorParagraph :: Category

pattern CategorySeparator :: Category

pattern CategoryControl :: Category

pattern CategoryFormat :: Category

pattern CategorySurrogate :: Category

pattern CategoryPrivateUse :: Category

pattern CategoryUnassigned :: Category

pattern CategoryCompatibility :: Category

pattern CategoryIgnoreGraphemeCluster :: Category

pattern CategoryIscntrl :: Category

pattern CategoryIsprint :: Category

pattern CategoryIsspace :: Category

pattern CategoryIsblank :: Category

pattern CategoryIsgraph :: Category

pattern CategoryIspunct :: Category

pattern CategoryIsalnum :: Category

pattern CategoryIsalpha :: Category

pattern CategoryIsupper :: Category

pattern CategoryIslower :: Category

pattern CategoryIsdigit :: Category

pattern CategoryIsxdigit :: Category

Misc

data TextException

Constructors

InvalidUTF8Exception CallStack

InvalidASCIIException CallStack

IndexOutOfTextRange Int CallStack

first payload is invalid char index

EmptyText CallStack

Instances

Show TextException

Defined in Z.Data.Text.Base

Methods

showsPrec :: Int -> TextException -> ShowS

show :: TextException -> String

showList :: [TextException] -> ShowS

Exception TextException

Defined in Z.Data.Text.Base

Methods

toException :: TextException -> SomeException

fromException :: SomeException -> Maybe TextException

displayException :: TextException -> String

errorEmptyText :: HasCallStack => a

c_utf8_validate_ba :: ByteArray# -> Int# -> Int# -> Int

c_utf8_validate_addr :: Addr# -> Int -> IO Int

c_ascii_validate_ba :: ByteArray# -> Int# -> Int# -> Int

c_ascii_validate_addr :: Addr# -> Int -> IO Int