Test.QuickCheck.Unicode

QuickCheck Generator and shrink functions for testing software that uses Unicode data.

The default Arbitrary instance for the Char type intentionally generates only ASCII values. This can lead to a false sense of security in cases where Unicode compliance is required, as encodings that span multiple bytes or code units will simply not be exercised at all.

This module deliberately avoids using the text and bytestring packages to avoid pulling in extra dependencies.

Newtype wrapper for convenience

data Unicode a

A wrapper for Char and String, for which the Arbitrary instance generates full-Unicode characters.

Instances

Eq a => Eq (Unicode a)

Methods

(==) :: Unicode a -> Unicode a -> Bool

(/=) :: Unicode a -> Unicode a -> Bool

Ord a => Ord (Unicode a)

Methods

compare :: Unicode a -> Unicode a -> Ordering

(<) :: Unicode a -> Unicode a -> Bool

(<=) :: Unicode a -> Unicode a -> Bool

(>) :: Unicode a -> Unicode a -> Bool

(>=) :: Unicode a -> Unicode a -> Bool

max :: Unicode a -> Unicode a -> Unicode a

min :: Unicode a -> Unicode a -> Unicode a

Read a => Read (Unicode a)

Methods

readsPrec :: Int -> ReadS (Unicode a)

readList :: ReadS [Unicode a]

readPrec :: ReadPrec (Unicode a)

readListPrec :: ReadPrec [Unicode a]

Show a => Show (Unicode a)

Methods

showsPrec :: Int -> Unicode a -> ShowS

show :: Unicode a -> String

showList :: [Unicode a] -> ShowS

Arbitrary (Unicode Char)

Methods

arbitrary :: Gen (Unicode Char)

shrink :: Unicode Char -> [Unicode Char]

Arbitrary (Unicode [Char])

Methods

arbitrary :: Gen (Unicode [Char])

shrink :: Unicode [Char] -> [Unicode [Char]]

Generators

char :: Gen Char

Generate a Unicode code point. This has a much larger range than the default Arbitrary instance for Char.

string :: Gen String

Generate a list of Unicode code points.

string1 :: Gen String

Generate a non-empty list of Unicode code points.

Helpers

list :: Gen a -> Gen [a]

Generate a list of values.

list1 :: Gen a -> Gen [a]

Generate a non-empty list of values.

Basic generators

planes :: [(Int, Gen Int)]

A weighted list of generators that favours ASCII characters, followed by planes 0 and 1.

ascii :: Gen Int

plane0 :: Gen Int

Basic Multilingual Plane.

plane1 :: Gen Int

Supplementary Multilingual Plane.

plane2 :: Gen Int

Supplementary Ideographic Plane.

plane14 :: Gen Int

Supplementary Special-Purpose Plane.

Predicates

reserved :: Int -> Bool

Indicate whether a code point is reserved.

Shrinking functions

shrinkChar :: Char -> [Char]

Shrink a Unicode code point.