{-# LANGUAGE DeriveTraversable, FlexibleInstances, Safe #-}

{-|
Module      : Data.Char.Braille
Description : A module used to render Braille characters in unicode.
Maintainer  : hapytexeu+gh@gmail.com
Stability   : experimental
Portability : POSIX

Unicode has a Braille segment for Braille with six dot cells, and a segment for Braille with eight dot cells, this module aims to make it more convenient to render such characters.
-}

module Data.Char.Braille(
    -- * Datastructures to store the state of the Braille character.
    Braille6(Braille6, top, middle, bottom)
  , Braille(Braille, row1, row2, row3, row4)
    -- * Converting 'Braille6' to 'Braille'
  , toBraille, toBraille'
    -- * Rendering Braille characters.
  , braille6, braille
    -- * Converting a character to 'Braille'
  , fromBraille6, fromBraille6', fromBraille, fromBraille'
  ) where

import Data.Bits((.&.), (.|.), shiftL, shiftR, testBit)
import Data.Bool(bool)
import Data.Char(chr, ord)
import Data.Char.Block(Row(Row))
import Data.Char.Core(UnicodeCharacter(toUnicodeChar, fromUnicodeChar, fromUnicodeChar'), UnicodeText)

import Test.QuickCheck.Arbitrary(Arbitrary(arbitrary), Arbitrary1(liftArbitrary), arbitrary1)

-- | A datastructure to render Braille patterns with six dots cells.
data Braille6 a = Braille6 {
    Braille6 a -> Row a
top :: Row a  -- ^ The state of the top row of the Braille character.
  , Braille6 a -> Row a
middle :: Row a  -- ^ The state of the middle row of the Braille character.
  , Braille6 a -> Row a
bottom :: Row a  -- ^ The state of the bottom row of the Braille character.
  } deriving (Braille6 a
Braille6 a -> Braille6 a -> Bounded (Braille6 a)
forall a. a -> a -> Bounded a
forall a. Bounded a => Braille6 a
maxBound :: Braille6 a
$cmaxBound :: forall a. Bounded a => Braille6 a
minBound :: Braille6 a
$cminBound :: forall a. Bounded a => Braille6 a
Bounded, Braille6 a -> Braille6 a -> Bool
(Braille6 a -> Braille6 a -> Bool)
-> (Braille6 a -> Braille6 a -> Bool) -> Eq (Braille6 a)
forall a. Eq a => Braille6 a -> Braille6 a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Braille6 a -> Braille6 a -> Bool
$c/= :: forall a. Eq a => Braille6 a -> Braille6 a -> Bool
== :: Braille6 a -> Braille6 a -> Bool
$c== :: forall a. Eq a => Braille6 a -> Braille6 a -> Bool
Eq, Braille6 a -> Bool
(a -> m) -> Braille6 a -> m
(a -> b -> b) -> b -> Braille6 a -> b
(forall m. Monoid m => Braille6 m -> m)
-> (forall m a. Monoid m => (a -> m) -> Braille6 a -> m)
-> (forall m a. Monoid m => (a -> m) -> Braille6 a -> m)
-> (forall a b. (a -> b -> b) -> b -> Braille6 a -> b)
-> (forall a b. (a -> b -> b) -> b -> Braille6 a -> b)
-> (forall b a. (b -> a -> b) -> b -> Braille6 a -> b)
-> (forall b a. (b -> a -> b) -> b -> Braille6 a -> b)
-> (forall a. (a -> a -> a) -> Braille6 a -> a)
-> (forall a. (a -> a -> a) -> Braille6 a -> a)
-> (forall a. Braille6 a -> [a])
-> (forall a. Braille6 a -> Bool)
-> (forall a. Braille6 a -> Int)
-> (forall a. Eq a => a -> Braille6 a -> Bool)
-> (forall a. Ord a => Braille6 a -> a)
-> (forall a. Ord a => Braille6 a -> a)
-> (forall a. Num a => Braille6 a -> a)
-> (forall a. Num a => Braille6 a -> a)
-> Foldable Braille6
forall a. Eq a => a -> Braille6 a -> Bool
forall a. Num a => Braille6 a -> a
forall a. Ord a => Braille6 a -> a
forall m. Monoid m => Braille6 m -> m
forall a. Braille6 a -> Bool
forall a. Braille6 a -> Int
forall a. Braille6 a -> [a]
forall a. (a -> a -> a) -> Braille6 a -> a
forall m a. Monoid m => (a -> m) -> Braille6 a -> m
forall b a. (b -> a -> b) -> b -> Braille6 a -> b
forall a b. (a -> b -> b) -> b -> Braille6 a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
product :: Braille6 a -> a
$cproduct :: forall a. Num a => Braille6 a -> a
sum :: Braille6 a -> a
$csum :: forall a. Num a => Braille6 a -> a
minimum :: Braille6 a -> a
$cminimum :: forall a. Ord a => Braille6 a -> a
maximum :: Braille6 a -> a
$cmaximum :: forall a. Ord a => Braille6 a -> a
elem :: a -> Braille6 a -> Bool
$celem :: forall a. Eq a => a -> Braille6 a -> Bool
length :: Braille6 a -> Int
$clength :: forall a. Braille6 a -> Int
null :: Braille6 a -> Bool
$cnull :: forall a. Braille6 a -> Bool
toList :: Braille6 a -> [a]
$ctoList :: forall a. Braille6 a -> [a]
foldl1 :: (a -> a -> a) -> Braille6 a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> Braille6 a -> a
foldr1 :: (a -> a -> a) -> Braille6 a -> a
$cfoldr1 :: forall a. (a -> a -> a) -> Braille6 a -> a
foldl' :: (b -> a -> b) -> b -> Braille6 a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> Braille6 a -> b
foldl :: (b -> a -> b) -> b -> Braille6 a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> Braille6 a -> b
foldr' :: (a -> b -> b) -> b -> Braille6 a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> Braille6 a -> b
foldr :: (a -> b -> b) -> b -> Braille6 a -> b
$cfoldr :: forall a b. (a -> b -> b) -> b -> Braille6 a -> b
foldMap' :: (a -> m) -> Braille6 a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> Braille6 a -> m
foldMap :: (a -> m) -> Braille6 a -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> Braille6 a -> m
fold :: Braille6 m -> m
$cfold :: forall m. Monoid m => Braille6 m -> m
Foldable, a -> Braille6 b -> Braille6 a
(a -> b) -> Braille6 a -> Braille6 b
(forall a b. (a -> b) -> Braille6 a -> Braille6 b)
-> (forall a b. a -> Braille6 b -> Braille6 a) -> Functor Braille6
forall a b. a -> Braille6 b -> Braille6 a
forall a b. (a -> b) -> Braille6 a -> Braille6 b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
<$ :: a -> Braille6 b -> Braille6 a
$c<$ :: forall a b. a -> Braille6 b -> Braille6 a
fmap :: (a -> b) -> Braille6 a -> Braille6 b
$cfmap :: forall a b. (a -> b) -> Braille6 a -> Braille6 b
Functor, Eq (Braille6 a)
Eq (Braille6 a)
-> (Braille6 a -> Braille6 a -> Ordering)
-> (Braille6 a -> Braille6 a -> Bool)
-> (Braille6 a -> Braille6 a -> Bool)
-> (Braille6 a -> Braille6 a -> Bool)
-> (Braille6 a -> Braille6 a -> Bool)
-> (Braille6 a -> Braille6 a -> Braille6 a)
-> (Braille6 a -> Braille6 a -> Braille6 a)
-> Ord (Braille6 a)
Braille6 a -> Braille6 a -> Bool
Braille6 a -> Braille6 a -> Ordering
Braille6 a -> Braille6 a -> Braille6 a
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
forall a. Ord a => Eq (Braille6 a)
forall a. Ord a => Braille6 a -> Braille6 a -> Bool
forall a. Ord a => Braille6 a -> Braille6 a -> Ordering
forall a. Ord a => Braille6 a -> Braille6 a -> Braille6 a
min :: Braille6 a -> Braille6 a -> Braille6 a
$cmin :: forall a. Ord a => Braille6 a -> Braille6 a -> Braille6 a
max :: Braille6 a -> Braille6 a -> Braille6 a
$cmax :: forall a. Ord a => Braille6 a -> Braille6 a -> Braille6 a
>= :: Braille6 a -> Braille6 a -> Bool
$c>= :: forall a. Ord a => Braille6 a -> Braille6 a -> Bool
> :: Braille6 a -> Braille6 a -> Bool
$c> :: forall a. Ord a => Braille6 a -> Braille6 a -> Bool
<= :: Braille6 a -> Braille6 a -> Bool
$c<= :: forall a. Ord a => Braille6 a -> Braille6 a -> Bool
< :: Braille6 a -> Braille6 a -> Bool
$c< :: forall a. Ord a => Braille6 a -> Braille6 a -> Bool
compare :: Braille6 a -> Braille6 a -> Ordering
$ccompare :: forall a. Ord a => Braille6 a -> Braille6 a -> Ordering
$cp1Ord :: forall a. Ord a => Eq (Braille6 a)
Ord, ReadPrec [Braille6 a]
ReadPrec (Braille6 a)
Int -> ReadS (Braille6 a)
ReadS [Braille6 a]
(Int -> ReadS (Braille6 a))
-> ReadS [Braille6 a]
-> ReadPrec (Braille6 a)
-> ReadPrec [Braille6 a]
-> Read (Braille6 a)
forall a. Read a => ReadPrec [Braille6 a]
forall a. Read a => ReadPrec (Braille6 a)
forall a. Read a => Int -> ReadS (Braille6 a)
forall a. Read a => ReadS [Braille6 a]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Braille6 a]
$creadListPrec :: forall a. Read a => ReadPrec [Braille6 a]
readPrec :: ReadPrec (Braille6 a)
$creadPrec :: forall a. Read a => ReadPrec (Braille6 a)
readList :: ReadS [Braille6 a]
$creadList :: forall a. Read a => ReadS [Braille6 a]
readsPrec :: Int -> ReadS (Braille6 a)
$creadsPrec :: forall a. Read a => Int -> ReadS (Braille6 a)
Read, Int -> Braille6 a -> ShowS
[Braille6 a] -> ShowS
Braille6 a -> String
(Int -> Braille6 a -> ShowS)
-> (Braille6 a -> String)
-> ([Braille6 a] -> ShowS)
-> Show (Braille6 a)
forall a. Show a => Int -> Braille6 a -> ShowS
forall a. Show a => [Braille6 a] -> ShowS
forall a. Show a => Braille6 a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Braille6 a] -> ShowS
$cshowList :: forall a. Show a => [Braille6 a] -> ShowS
show :: Braille6 a -> String
$cshow :: forall a. Show a => Braille6 a -> String
showsPrec :: Int -> Braille6 a -> ShowS
$cshowsPrec :: forall a. Show a => Int -> Braille6 a -> ShowS
Show, Functor Braille6
Foldable Braille6
Functor Braille6
-> Foldable Braille6
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> Braille6 a -> f (Braille6 b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    Braille6 (f a) -> f (Braille6 a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> Braille6 a -> m (Braille6 b))
-> (forall (m :: * -> *) a.
    Monad m =>
    Braille6 (m a) -> m (Braille6 a))
-> Traversable Braille6
(a -> f b) -> Braille6 a -> f (Braille6 b)
forall (t :: * -> *).
Functor t
-> Foldable t
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a. Monad m => Braille6 (m a) -> m (Braille6 a)
forall (f :: * -> *) a.
Applicative f =>
Braille6 (f a) -> f (Braille6 a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Braille6 a -> m (Braille6 b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Braille6 a -> f (Braille6 b)
sequence :: Braille6 (m a) -> m (Braille6 a)
$csequence :: forall (m :: * -> *) a. Monad m => Braille6 (m a) -> m (Braille6 a)
mapM :: (a -> m b) -> Braille6 a -> m (Braille6 b)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Braille6 a -> m (Braille6 b)
sequenceA :: Braille6 (f a) -> f (Braille6 a)
$csequenceA :: forall (f :: * -> *) a.
Applicative f =>
Braille6 (f a) -> f (Braille6 a)
traverse :: (a -> f b) -> Braille6 a -> f (Braille6 b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Braille6 a -> f (Braille6 b)
$cp2Traversable :: Foldable Braille6
$cp1Traversable :: Functor Braille6
Traversable)

-- | A datastructure to render Braille patterns with eight dots cells.
data Braille a = Braille {
    Braille a -> Row a
row1 :: Row a  -- ^ The state of the top row of the Braille character.
  , Braille a -> Row a
row2 :: Row a  -- ^ The state of the second row of the Braille character.
  , Braille a -> Row a
row3 :: Row a  -- ^ The state of the third row of the Braille character.
  , Braille a -> Row a
row4 :: Row a  -- ^ The state of the bottom row of the Braille character.
  } deriving (Braille a
Braille a -> Braille a -> Bounded (Braille a)
forall a. a -> a -> Bounded a
forall a. Bounded a => Braille a
maxBound :: Braille a
$cmaxBound :: forall a. Bounded a => Braille a
minBound :: Braille a
$cminBound :: forall a. Bounded a => Braille a
Bounded, Braille a -> Braille a -> Bool
(Braille a -> Braille a -> Bool)
-> (Braille a -> Braille a -> Bool) -> Eq (Braille a)
forall a. Eq a => Braille a -> Braille a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Braille a -> Braille a -> Bool
$c/= :: forall a. Eq a => Braille a -> Braille a -> Bool
== :: Braille a -> Braille a -> Bool
$c== :: forall a. Eq a => Braille a -> Braille a -> Bool
Eq, Braille a -> Bool
(a -> m) -> Braille a -> m
(a -> b -> b) -> b -> Braille a -> b
(forall m. Monoid m => Braille m -> m)
-> (forall m a. Monoid m => (a -> m) -> Braille a -> m)
-> (forall m a. Monoid m => (a -> m) -> Braille a -> m)
-> (forall a b. (a -> b -> b) -> b -> Braille a -> b)
-> (forall a b. (a -> b -> b) -> b -> Braille a -> b)
-> (forall b a. (b -> a -> b) -> b -> Braille a -> b)
-> (forall b a. (b -> a -> b) -> b -> Braille a -> b)
-> (forall a. (a -> a -> a) -> Braille a -> a)
-> (forall a. (a -> a -> a) -> Braille a -> a)
-> (forall a. Braille a -> [a])
-> (forall a. Braille a -> Bool)
-> (forall a. Braille a -> Int)
-> (forall a. Eq a => a -> Braille a -> Bool)
-> (forall a. Ord a => Braille a -> a)
-> (forall a. Ord a => Braille a -> a)
-> (forall a. Num a => Braille a -> a)
-> (forall a. Num a => Braille a -> a)
-> Foldable Braille
forall a. Eq a => a -> Braille a -> Bool
forall a. Num a => Braille a -> a
forall a. Ord a => Braille a -> a
forall m. Monoid m => Braille m -> m
forall a. Braille a -> Bool
forall a. Braille a -> Int
forall a. Braille a -> [a]
forall a. (a -> a -> a) -> Braille a -> a
forall m a. Monoid m => (a -> m) -> Braille a -> m
forall b a. (b -> a -> b) -> b -> Braille a -> b
forall a b. (a -> b -> b) -> b -> Braille a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
product :: Braille a -> a
$cproduct :: forall a. Num a => Braille a -> a
sum :: Braille a -> a
$csum :: forall a. Num a => Braille a -> a
minimum :: Braille a -> a
$cminimum :: forall a. Ord a => Braille a -> a
maximum :: Braille a -> a
$cmaximum :: forall a. Ord a => Braille a -> a
elem :: a -> Braille a -> Bool
$celem :: forall a. Eq a => a -> Braille a -> Bool
length :: Braille a -> Int
$clength :: forall a. Braille a -> Int
null :: Braille a -> Bool
$cnull :: forall a. Braille a -> Bool
toList :: Braille a -> [a]
$ctoList :: forall a. Braille a -> [a]
foldl1 :: (a -> a -> a) -> Braille a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> Braille a -> a
foldr1 :: (a -> a -> a) -> Braille a -> a
$cfoldr1 :: forall a. (a -> a -> a) -> Braille a -> a
foldl' :: (b -> a -> b) -> b -> Braille a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> Braille a -> b
foldl :: (b -> a -> b) -> b -> Braille a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> Braille a -> b
foldr' :: (a -> b -> b) -> b -> Braille a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> Braille a -> b
foldr :: (a -> b -> b) -> b -> Braille a -> b
$cfoldr :: forall a b. (a -> b -> b) -> b -> Braille a -> b
foldMap' :: (a -> m) -> Braille a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> Braille a -> m
foldMap :: (a -> m) -> Braille a -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> Braille a -> m
fold :: Braille m -> m
$cfold :: forall m. Monoid m => Braille m -> m
Foldable, a -> Braille b -> Braille a
(a -> b) -> Braille a -> Braille b
(forall a b. (a -> b) -> Braille a -> Braille b)
-> (forall a b. a -> Braille b -> Braille a) -> Functor Braille
forall a b. a -> Braille b -> Braille a
forall a b. (a -> b) -> Braille a -> Braille b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
<$ :: a -> Braille b -> Braille a
$c<$ :: forall a b. a -> Braille b -> Braille a
fmap :: (a -> b) -> Braille a -> Braille b
$cfmap :: forall a b. (a -> b) -> Braille a -> Braille b
Functor, Eq (Braille a)
Eq (Braille a)
-> (Braille a -> Braille a -> Ordering)
-> (Braille a -> Braille a -> Bool)
-> (Braille a -> Braille a -> Bool)
-> (Braille a -> Braille a -> Bool)
-> (Braille a -> Braille a -> Bool)
-> (Braille a -> Braille a -> Braille a)
-> (Braille a -> Braille a -> Braille a)
-> Ord (Braille a)
Braille a -> Braille a -> Bool
Braille a -> Braille a -> Ordering
Braille a -> Braille a -> Braille a
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
forall a. Ord a => Eq (Braille a)
forall a. Ord a => Braille a -> Braille a -> Bool
forall a. Ord a => Braille a -> Braille a -> Ordering
forall a. Ord a => Braille a -> Braille a -> Braille a
min :: Braille a -> Braille a -> Braille a
$cmin :: forall a. Ord a => Braille a -> Braille a -> Braille a
max :: Braille a -> Braille a -> Braille a
$cmax :: forall a. Ord a => Braille a -> Braille a -> Braille a
>= :: Braille a -> Braille a -> Bool
$c>= :: forall a. Ord a => Braille a -> Braille a -> Bool
> :: Braille a -> Braille a -> Bool
$c> :: forall a. Ord a => Braille a -> Braille a -> Bool
<= :: Braille a -> Braille a -> Bool
$c<= :: forall a. Ord a => Braille a -> Braille a -> Bool
< :: Braille a -> Braille a -> Bool
$c< :: forall a. Ord a => Braille a -> Braille a -> Bool
compare :: Braille a -> Braille a -> Ordering
$ccompare :: forall a. Ord a => Braille a -> Braille a -> Ordering
$cp1Ord :: forall a. Ord a => Eq (Braille a)
Ord, ReadPrec [Braille a]
ReadPrec (Braille a)
Int -> ReadS (Braille a)
ReadS [Braille a]
(Int -> ReadS (Braille a))
-> ReadS [Braille a]
-> ReadPrec (Braille a)
-> ReadPrec [Braille a]
-> Read (Braille a)
forall a. Read a => ReadPrec [Braille a]
forall a. Read a => ReadPrec (Braille a)
forall a. Read a => Int -> ReadS (Braille a)
forall a. Read a => ReadS [Braille a]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Braille a]
$creadListPrec :: forall a. Read a => ReadPrec [Braille a]
readPrec :: ReadPrec (Braille a)
$creadPrec :: forall a. Read a => ReadPrec (Braille a)
readList :: ReadS [Braille a]
$creadList :: forall a. Read a => ReadS [Braille a]
readsPrec :: Int -> ReadS (Braille a)
$creadsPrec :: forall a. Read a => Int -> ReadS (Braille a)
Read, Int -> Braille a -> ShowS
[Braille a] -> ShowS
Braille a -> String
(Int -> Braille a -> ShowS)
-> (Braille a -> String)
-> ([Braille a] -> ShowS)
-> Show (Braille a)
forall a. Show a => Int -> Braille a -> ShowS
forall a. Show a => [Braille a] -> ShowS
forall a. Show a => Braille a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Braille a] -> ShowS
$cshowList :: forall a. Show a => [Braille a] -> ShowS
show :: Braille a -> String
$cshow :: forall a. Show a => Braille a -> String
showsPrec :: Int -> Braille a -> ShowS
$cshowsPrec :: forall a. Show a => Int -> Braille a -> ShowS
Show, Functor Braille
Foldable Braille
Functor Braille
-> Foldable Braille
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> Braille a -> f (Braille b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    Braille (f a) -> f (Braille a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> Braille a -> m (Braille b))
-> (forall (m :: * -> *) a.
    Monad m =>
    Braille (m a) -> m (Braille a))
-> Traversable Braille
(a -> f b) -> Braille a -> f (Braille b)
forall (t :: * -> *).
Functor t
-> Foldable t
-> (forall (f :: * -> *) a b.
    Applicative f =>
    (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a. Monad m => Braille (m a) -> m (Braille a)
forall (f :: * -> *) a.
Applicative f =>
Braille (f a) -> f (Braille a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Braille a -> m (Braille b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Braille a -> f (Braille b)
sequence :: Braille (m a) -> m (Braille a)
$csequence :: forall (m :: * -> *) a. Monad m => Braille (m a) -> m (Braille a)
mapM :: (a -> m b) -> Braille a -> m (Braille b)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> Braille a -> m (Braille b)
sequenceA :: Braille (f a) -> f (Braille a)
$csequenceA :: forall (f :: * -> *) a.
Applicative f =>
Braille (f a) -> f (Braille a)
traverse :: (a -> f b) -> Braille a -> f (Braille b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Braille a -> f (Braille b)
$cp2Traversable :: Foldable Braille
$cp1Traversable :: Functor Braille
Traversable)

-- | Convert a 'Braille6' value to a 'Braille' character, by putting in a given
-- value at the two values at the bottom row.
toBraille'
  :: a  -- ^ The value to put in the cells of the bottom row.
  -> Braille6 a  -- ^ The given 'Braille6' value to convert.
  -> Braille a  -- ^ A 'Braille' value that uses as bottom two values given as first parameter.
toBraille' :: a -> Braille6 a -> Braille a
toBraille' a
d (Braille6 Row a
r0 Row a
r1 Row a
r2) = Row a -> Row a -> Row a -> Row a -> Braille a
forall a. Row a -> Row a -> Row a -> Row a -> Braille a
Braille Row a
r0 Row a
r1 Row a
r2 (a -> a -> Row a
forall a. a -> a -> Row a
Row a
d a
d)

-- | Convert a 'Braille6' value to a 'Braille6' character by setting the bottom
-- row with two 'False' values.
toBraille
  :: Braille6 Bool  -- ^ The given 'Braille6' value to convert.
  -> Braille Bool  -- ^ A 'Braille' value that uses as bottom two times 'False'.
toBraille :: Braille6 Bool -> Braille Bool
toBraille = Bool -> Braille6 Bool -> Braille Bool
forall a. a -> Braille6 a -> Braille a
toBraille' Bool
False

-- | Convert the given 'Char'acter to a 'Braille' object of 'Bool's. If the
-- given character is not a /Braille/ character, the result is unspecified.
fromBraille'
  :: Char  -- ^ The given 'Char'acter to convert.
  -> Braille Bool  -- ^ The corresponding 'Braille' object of 'Bool's.
fromBraille' :: Char -> Braille Bool
fromBraille' Char
c = Row Bool -> Row Bool -> Row Bool -> Row Bool -> Braille Bool
forall a. Row a -> Row a -> Row a -> Row a -> Braille a
Braille (Int -> Row Bool
go Int
0x00) (Int -> Row Bool
go Int
0x01) (Int -> Row Bool
go Int
0x02) (Bool -> Bool -> Row Bool
forall a. a -> a -> Row a
Row (Int -> Bool
tB' Int
0x03) (Int -> Bool
tB' Int
0x04))
    where b :: Int
b = Char -> Int
ord Char
c Int -> Int -> Int
forall a. Bits a => a -> a -> a
.&. Int
0xff
          tB :: Int -> Bool
tB = Int -> Int -> Bool
forall a. Bits a => a -> Int -> Bool
testBit Int
b
          tB' :: Int -> Bool
tB' = Int -> Int -> Bool
forall a. Bits a => a -> Int -> Bool
testBit (Int -> Int -> Int
forall a. Bits a => a -> Int -> a
shiftR Int
b Int
3)
          go :: Int -> Row Bool
go Int
n = Bool -> Bool -> Row Bool
forall a. a -> a -> Row a
Row (Int -> Bool
tB Int
n) (Int -> Bool
tB' Int
n)

-- | Convert the given 'Char'acter to a 'Braille6' object of 'Bool's. If the
-- given character is not a /Braille/ character, or a /Braille/ character where
-- the lowest row contains filled dots, then the result is unspecified.
fromBraille6'
  :: Char  -- ^ The given 'Char'acter to convert.
  -> Braille6 Bool  -- ^ The corresponding 'Braille6' object of 'Bool's.
fromBraille6' :: Char -> Braille6 Bool
fromBraille6' Char
c = Row Bool -> Row Bool -> Row Bool -> Braille6 Bool
forall a. Row a -> Row a -> Row a -> Braille6 a
Braille6 (Int -> Row Bool
go Int
0x00) (Int -> Row Bool
go Int
0x01) (Int -> Row Bool
go Int
0x02)
    where b :: Int
b = Char -> Int
ord Char
c Int -> Int -> Int
forall a. Bits a => a -> a -> a
.&. Int
0x3f
          go :: Int -> Row Bool
go Int
n = Bool -> Bool -> Row Bool
forall a. a -> a -> Row a
Row (Int -> Int -> Bool
forall a. Bits a => a -> Int -> Bool
testBit Int
b Int
n) (Int -> Int -> Bool
forall a. Bits a => a -> Int -> Bool
testBit (Int -> Int -> Int
forall a. Bits a => a -> Int -> a
shiftR Int
b Int
3) Int
n)

-- | Convert the given 'Char'acter to a 'Braille' object of 'Bool's wrapped in
-- a 'Just'. If the given character is not a /Braille/ character, 'Nothing' is
-- returned.
fromBraille
  :: Char  -- ^ The given 'Char'acter to convert.
  -> Maybe (Braille Bool)  -- ^ The equivalent 'Braille6' object of 'Bool's wrapped in a 'Just' if it exists; 'Nothing' otherwise.
fromBraille :: Char -> Maybe (Braille Bool)
fromBraille Char
c
    | Char
'\x2800' Char -> Char -> Bool
forall a. Ord a => a -> a -> Bool
> Char
c Bool -> Bool -> Bool
|| Char
c Char -> Char -> Bool
forall a. Ord a => a -> a -> Bool
> Char
'\x28ff' = Maybe (Braille Bool)
forall a. Maybe a
Nothing
    | Bool
otherwise = Braille Bool -> Maybe (Braille Bool)
forall a. a -> Maybe a
Just (Char -> Braille Bool
fromBraille' Char
c)

-- | Convert the given 'Char'acter to a 'Braille6' object of 'Bool's wrapped in
-- a 'Just'. If the given character is not a /Braille/ character, or a /Braille/
-- character where the lowest row contains filled dots, 'Nothing' is returned.
fromBraille6
  :: Char  -- ^ The given 'Char'acter to convert.
  -> Maybe (Braille6 Bool)  -- ^ The equivalent 'Braille6' object of 'Bool's wrapped in a 'Just' if it exists; 'Nothing' otherwise.
fromBraille6 :: Char -> Maybe (Braille6 Bool)
fromBraille6 Char
c
    | Char
'\x2800' Char -> Char -> Bool
forall a. Ord a => a -> a -> Bool
> Char
c Bool -> Bool -> Bool
|| Char
c Char -> Char -> Bool
forall a. Ord a => a -> a -> Bool
> Char
'\x283f' = Maybe (Braille6 Bool)
forall a. Maybe a
Nothing
    | Bool
otherwise = Braille6 Bool -> Maybe (Braille6 Bool)
forall a. a -> Maybe a
Just (Char -> Braille6 Bool
fromBraille6' Char
c)


instance Arbitrary a => Arbitrary (Braille6 a) where
    arbitrary :: Gen (Braille6 a)
arbitrary = Gen (Braille6 a)
forall (f :: * -> *) a. (Arbitrary1 f, Arbitrary a) => Gen (f a)
arbitrary1

instance Arbitrary1 Braille6 where
    liftArbitrary :: Gen a -> Gen (Braille6 a)
liftArbitrary Gen a
arb = Row a -> Row a -> Row a -> Braille6 a
forall a. Row a -> Row a -> Row a -> Braille6 a
Braille6 (Row a -> Row a -> Row a -> Braille6 a)
-> Gen (Row a) -> Gen (Row a -> Row a -> Braille6 a)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen (Row a)
arb' Gen (Row a -> Row a -> Braille6 a)
-> Gen (Row a) -> Gen (Row a -> Braille6 a)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen (Row a)
arb' Gen (Row a -> Braille6 a) -> Gen (Row a) -> Gen (Braille6 a)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen (Row a)
arb'
        where arb' :: Gen (Row a)
arb' = Gen a -> Gen (Row a)
forall (f :: * -> *) a. Arbitrary1 f => Gen a -> Gen (f a)
liftArbitrary Gen a
arb

instance Arbitrary a => Arbitrary (Braille a) where
    arbitrary :: Gen (Braille a)
arbitrary = Gen (Braille a)
forall (f :: * -> *) a. (Arbitrary1 f, Arbitrary a) => Gen (f a)
arbitrary1

instance Arbitrary1 Braille where
    liftArbitrary :: Gen a -> Gen (Braille a)
liftArbitrary Gen a
arb = Row a -> Row a -> Row a -> Row a -> Braille a
forall a. Row a -> Row a -> Row a -> Row a -> Braille a
Braille (Row a -> Row a -> Row a -> Row a -> Braille a)
-> Gen (Row a) -> Gen (Row a -> Row a -> Row a -> Braille a)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Gen (Row a)
arb' Gen (Row a -> Row a -> Row a -> Braille a)
-> Gen (Row a) -> Gen (Row a -> Row a -> Braille a)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen (Row a)
arb' Gen (Row a -> Row a -> Braille a)
-> Gen (Row a) -> Gen (Row a -> Braille a)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen (Row a)
arb' Gen (Row a -> Braille a) -> Gen (Row a) -> Gen (Braille a)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> Gen (Row a)
arb'
        where arb' :: Gen (Row a)
arb' = Gen a -> Gen (Row a)
forall (f :: * -> *) a. Arbitrary1 f => Gen a -> Gen (f a)
liftArbitrary Gen a
arb

_rowValue' :: Int -> Row Bool -> Int
_rowValue' :: Int -> Row Bool -> Int
_rowValue' Int
d (Row Bool
b0 Bool
b1) = Int -> Int -> Bool -> Int
forall a. a -> a -> Bool -> a
bool Int
0 Int
1 Bool
b0 Int -> Int -> Int
forall a. Bits a => a -> a -> a
.|. Int -> Int -> Bool -> Int
forall a. a -> a -> Bool -> a
bool Int
0 Int
d Bool
b1

_rowValue :: Row Bool -> Int
_rowValue :: Row Bool -> Int
_rowValue = Int -> Row Bool -> Int
_rowValue' Int
8

-- | Convert the given 'Braille6' value to a unicode character representing this
-- Braille value.
braille6 :: Braille6 Bool -> Char
braille6 :: Braille6 Bool -> Char
braille6 = Braille Bool -> Char
braille (Braille Bool -> Char)
-> (Braille6 Bool -> Braille Bool) -> Braille6 Bool -> Char
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Braille6 Bool -> Braille Bool
toBraille

-- | Convert the given 'Braille' value to a unicode character representing this
-- braille value.
braille :: Braille Bool -> Char
braille :: Braille Bool -> Char
braille (Braille Row Bool
r1 Row Bool
r2 Row Bool
r3 Row Bool
r4) = Int -> Char
chr (Int
0x2800 Int -> Int -> Int
forall a. Bits a => a -> a -> a
.|. Row Bool -> Int
_rowValue Row Bool
r1 Int -> Int -> Int
forall a. Bits a => a -> a -> a
.|. Int -> Int -> Int
forall a. Bits a => a -> Int -> a
shiftL (Row Bool -> Int
_rowValue Row Bool
r2) Int
1 Int -> Int -> Int
forall a. Bits a => a -> a -> a
.|. Int -> Int -> Int
forall a. Bits a => a -> Int -> a
shiftL (Row Bool -> Int
_rowValue Row Bool
r3) Int
2 Int -> Int -> Int
forall a. Bits a => a -> a -> a
.|. Int -> Int -> Int
forall a. Bits a => a -> Int -> a
shiftL (Int -> Row Bool -> Int
_rowValue' Int
2 Row Bool
r4) Int
6)

instance UnicodeCharacter (Braille Bool) where
    toUnicodeChar :: Braille Bool -> Char
toUnicodeChar = Braille Bool -> Char
braille
    fromUnicodeChar :: Char -> Maybe (Braille Bool)
fromUnicodeChar = Char -> Maybe (Braille Bool)
fromBraille
    fromUnicodeChar' :: Char -> Braille Bool
fromUnicodeChar' = Char -> Braille Bool
fromBraille'

instance UnicodeCharacter (Braille6 Bool) where
    toUnicodeChar :: Braille6 Bool -> Char
toUnicodeChar = Braille6 Bool -> Char
braille6
    fromUnicodeChar :: Char -> Maybe (Braille6 Bool)
fromUnicodeChar = Char -> Maybe (Braille6 Bool)
fromBraille6
    fromUnicodeChar' :: Char -> Braille6 Bool
fromUnicodeChar' = Char -> Braille6 Bool
fromBraille6'

instance UnicodeText (Braille Bool)
instance UnicodeText (Braille6 Bool)